<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>video_common: xvidc.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">video_common
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xvidc_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xvidc.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_vid_c___video_timing.html">XVidC_VideoTiming</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Video timing structure.  <a href="struct_x_vid_c___video_timing.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_vid_c__3_d_sampling_info.html">XVidC_3DSamplingInfo</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">3D Sampling info structure.  <a href="struct_x_vid_c__3_d_sampling_info.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_vid_c__3_d_info.html">XVidC_3DInfo</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">3D info structure.  <a href="struct_x_vid_c__3_d_info.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_vid_c___video_stream.html">XVidC_VideoStream</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Video stream structure.  <a href="struct_x_vid_c___video_stream.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_vid_c___video_window.html">XVidC_VideoWindow</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Video window structure.  <a href="struct_x_vid_c___video_window.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_vid_c___video_timing_mode.html">XVidC_VideoTimingMode</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Video timing mode from the video timing table.  <a href="struct_x_vid_c___video_timing_mode.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga6dfce65c055846fe2904670184ae631f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__common.html#ga6dfce65c055846fe2904670184ae631f">XVidC_IsStream3D</a>(VidStreamPtr)&#160;&#160;&#160;((VidStreamPtr)-&gt;Is3D)</td></tr>
<tr class="memdesc:ga6dfce65c055846fe2904670184ae631f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This macro check if video stream is 3D or 2D.  <a href="group__video__common.html#ga6dfce65c055846fe2904670184ae631f">More...</a><br/></td></tr>
<tr class="separator:ga6dfce65c055846fe2904670184ae631f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gae286bc520a23dd835ab0ddd648b208a9"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__common.html#gae286bc520a23dd835ab0ddd648b208a9">XVidC_DelayHandler</a> )(void *TimerPtr, u32 Delay)</td></tr>
<tr class="memdesc:gae286bc520a23dd835ab0ddd648b208a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Callback type which represents a custom timer wait handler.  <a href="group__video__common.html#gae286bc520a23dd835ab0ddd648b208a9">More...</a><br/></td></tr>
<tr class="separator:gae286bc520a23dd835ab0ddd648b208a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga562f08faf2fc329b1cd7147b3d66ef53"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__common.html#ga562f08faf2fc329b1cd7147b3d66ef53">XVidC_VideoMode</a> </td></tr>
<tr class="memdesc:ga562f08faf2fc329b1cd7147b3d66ef53"><td class="mdescLeft">&#160;</td><td class="mdescRight">This typedef enumerates the list of available standard display monitor timings as specified in the <a class="el" href="xvidc__timings__table_8c.html">xvidc_timings_table.c</a> file.  <a href="group__video__common.html#ga562f08faf2fc329b1cd7147b3d66ef53">More...</a><br/></td></tr>
<tr class="separator:ga562f08faf2fc329b1cd7147b3d66ef53"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae8750e69caf5a7f747fbf410b14f447e"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__common.html#gae8750e69caf5a7f747fbf410b14f447e">XVidC_VideoFormat</a> </td></tr>
<tr class="memdesc:gae8750e69caf5a7f747fbf410b14f447e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Progressive/interlaced video format.  <a href="group__video__common.html#gae8750e69caf5a7f747fbf410b14f447e">More...</a><br/></td></tr>
<tr class="separator:gae8750e69caf5a7f747fbf410b14f447e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac192cb9c275d8ef2c985646f420c1a4e"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__common.html#gac192cb9c275d8ef2c985646f420c1a4e">XVidC_FrameRate</a> </td></tr>
<tr class="memdesc:gac192cb9c275d8ef2c985646f420c1a4e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Frame rate.  <a href="group__video__common.html#gac192cb9c275d8ef2c985646f420c1a4e">More...</a><br/></td></tr>
<tr class="separator:gac192cb9c275d8ef2c985646f420c1a4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8006bc80e39c26ee0081647990b9fedc"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__common.html#ga8006bc80e39c26ee0081647990b9fedc">XVidC_ColorDepth</a> </td></tr>
<tr class="memdesc:ga8006bc80e39c26ee0081647990b9fedc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Color depth - bits per color component.  <a href="group__video__common.html#ga8006bc80e39c26ee0081647990b9fedc">More...</a><br/></td></tr>
<tr class="separator:ga8006bc80e39c26ee0081647990b9fedc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga37beb8afba8203e270e2df7e67f720ec"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__common.html#ga37beb8afba8203e270e2df7e67f720ec">XVidC_PixelsPerClock</a> </td></tr>
<tr class="memdesc:ga37beb8afba8203e270e2df7e67f720ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pixels per clock.  <a href="group__video__common.html#ga37beb8afba8203e270e2df7e67f720ec">More...</a><br/></td></tr>
<tr class="separator:ga37beb8afba8203e270e2df7e67f720ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa562703f77eeee8ef4a222f1b99c8633"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__common.html#gaa562703f77eeee8ef4a222f1b99c8633">XVidC_ColorFormat</a> </td></tr>
<tr class="memdesc:gaa562703f77eeee8ef4a222f1b99c8633"><td class="mdescLeft">&#160;</td><td class="mdescRight">Color space format.  <a href="group__video__common.html#gaa562703f77eeee8ef4a222f1b99c8633">More...</a><br/></td></tr>
<tr class="separator:gaa562703f77eeee8ef4a222f1b99c8633"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga81fffe43e2a09eac1799124f1a1504de"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__common.html#ga81fffe43e2a09eac1799124f1a1504de">XVidC_TileSize</a> </td></tr>
<tr class="memdesc:ga81fffe43e2a09eac1799124f1a1504de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tile Size in Tile format.  <a href="group__video__common.html#ga81fffe43e2a09eac1799124f1a1504de">More...</a><br/></td></tr>
<tr class="separator:ga81fffe43e2a09eac1799124f1a1504de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga22adc237b6c47579463b366d25180172"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__common.html#ga22adc237b6c47579463b366d25180172">XVidC_AspectRatio</a> </td></tr>
<tr class="memdesc:ga22adc237b6c47579463b366d25180172"><td class="mdescLeft">&#160;</td><td class="mdescRight">Image Aspect Ratio.  <a href="group__video__common.html#ga22adc237b6c47579463b366d25180172">More...</a><br/></td></tr>
<tr class="separator:ga22adc237b6c47579463b366d25180172"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabde81f3f568095c842d4669a4c62ed88"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__common.html#gabde81f3f568095c842d4669a4c62ed88">XVidC_ColorStd</a> </td></tr>
<tr class="memdesc:gabde81f3f568095c842d4669a4c62ed88"><td class="mdescLeft">&#160;</td><td class="mdescRight">Color space conversion standard.  <a href="group__video__common.html#gabde81f3f568095c842d4669a4c62ed88">More...</a><br/></td></tr>
<tr class="separator:gabde81f3f568095c842d4669a4c62ed88"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5498ff9698bbb64fdf20a578ac1fc15f"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__common.html#ga5498ff9698bbb64fdf20a578ac1fc15f">XVidC_ColorRange</a> </td></tr>
<tr class="memdesc:ga5498ff9698bbb64fdf20a578ac1fc15f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Color conversion output range.  <a href="group__video__common.html#ga5498ff9698bbb64fdf20a578ac1fc15f">More...</a><br/></td></tr>
<tr class="separator:ga5498ff9698bbb64fdf20a578ac1fc15f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3f5c78f83e56747ade72ebb51cafffc5"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__common.html#ga3f5c78f83e56747ade72ebb51cafffc5">XVidC_3DFormat</a> { <br/>
&#160;&#160;<a class="el" href="group__video__common.html#gga3f5c78f83e56747ade72ebb51cafffc5afe8a8bd6b0c39671dca3f265464ff380">XVIDC_3D_FRAME_PACKING</a> = 0, 
<a class="el" href="group__video__common.html#gga3f5c78f83e56747ade72ebb51cafffc5a0aa6e3a807e663d6d2a4751de888f36c">XVIDC_3D_FIELD_ALTERNATIVE</a>, 
<a class="el" href="group__video__common.html#gga3f5c78f83e56747ade72ebb51cafffc5a9be4866820bd65de0a8a808d6e4907ee">XVIDC_3D_LINE_ALTERNATIVE</a>, 
<a class="el" href="group__video__common.html#gga3f5c78f83e56747ade72ebb51cafffc5ae86dbfde610277e011b6bcc8cf6127c9">XVIDC_3D_SIDE_BY_SIDE_FULL</a>, 
<br/>
&#160;&#160;<a class="el" href="group__video__common.html#gga3f5c78f83e56747ade72ebb51cafffc5a75b1eb1e2ee23c9e8d099de077b8dd1c">XVIDC_3D_TOP_AND_BOTTOM_HALF</a>, 
<a class="el" href="group__video__common.html#gga3f5c78f83e56747ade72ebb51cafffc5a8f23971be18a78f5957611d53750dfff">XVIDC_3D_SIDE_BY_SIDE_HALF</a>
<br/>
 }</td></tr>
<tr class="memdesc:ga3f5c78f83e56747ade72ebb51cafffc5"><td class="mdescLeft">&#160;</td><td class="mdescRight">3D formats.  <a href="group__video__common.html#ga3f5c78f83e56747ade72ebb51cafffc5">More...</a><br/></td></tr>
<tr class="separator:ga3f5c78f83e56747ade72ebb51cafffc5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad69f9da8f23751ed41b14fefd5bb7662"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__common.html#gad69f9da8f23751ed41b14fefd5bb7662">XVidC_3DSamplingMethod</a> { <a class="el" href="group__video__common.html#ggad69f9da8f23751ed41b14fefd5bb7662a95493248a3113bf760053d8ac31d44b4">XVIDC_3D_SAMPLING_HORIZONTAL</a> = 0, 
<a class="el" href="group__video__common.html#ggad69f9da8f23751ed41b14fefd5bb7662a21f3e5a0ffcbc11f4da90f2f0baa23ca">XVIDC_3D_SAMPLING_QUINCUNX</a>
 }</td></tr>
<tr class="memdesc:gad69f9da8f23751ed41b14fefd5bb7662"><td class="mdescLeft">&#160;</td><td class="mdescRight">3D Sub-sampling methods.  <a href="group__video__common.html#gad69f9da8f23751ed41b14fefd5bb7662">More...</a><br/></td></tr>
<tr class="separator:gad69f9da8f23751ed41b14fefd5bb7662"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga58c9217723db2f22f7d57c97b2cae8e1"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__common.html#ga58c9217723db2f22f7d57c97b2cae8e1">XVidC_3DSamplingPosition</a> { <a class="el" href="group__video__common.html#gga58c9217723db2f22f7d57c97b2cae8e1aa7f2d683e0c4c05a0e5e7ecb469a0a4e">XVIDC_3D_SAMPPOS_OLOR</a> = 0, 
<a class="el" href="group__video__common.html#gga58c9217723db2f22f7d57c97b2cae8e1afcc9586976a32c00296910f0a62c02db">XVIDC_3D_SAMPPOS_OLER</a>, 
<a class="el" href="group__video__common.html#gga58c9217723db2f22f7d57c97b2cae8e1a5ea1a3ae7bf91b1d9eb9c7458bed5ab1">XVIDC_3D_SAMPPOS_ELOR</a>, 
<a class="el" href="group__video__common.html#gga58c9217723db2f22f7d57c97b2cae8e1a43e930979c515643180869ac40972e1e">XVIDC_3D_SAMPPOS_ELER</a>
 }</td></tr>
<tr class="memdesc:ga58c9217723db2f22f7d57c97b2cae8e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">3D Sub-sampling positions.  <a href="group__video__common.html#ga58c9217723db2f22f7d57c97b2cae8e1">More...</a><br/></td></tr>
<tr class="separator:ga58c9217723db2f22f7d57c97b2cae8e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae3a2bcd6e9ee30dfff64cd236b6841bf"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__common.html#gae3a2bcd6e9ee30dfff64cd236b6841bf">XVidC_Eotf</a> </td></tr>
<tr class="memdesc:gae3a2bcd6e9ee30dfff64cd236b6841bf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Electro Optical Transfer Function.  <a href="group__video__common.html#gae3a2bcd6e9ee30dfff64cd236b6841bf">More...</a><br/></td></tr>
<tr class="separator:gae3a2bcd6e9ee30dfff64cd236b6841bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga687eb5fbcb487fa34c66099941b7a8f0"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__common.html#ga687eb5fbcb487fa34c66099941b7a8f0">XVidC_RegisterCustomTimingModes</a> (const <a class="el" href="struct_x_vid_c___video_timing_mode.html">XVidC_VideoTimingMode</a> *CustomTable, u16 NumElems)</td></tr>
<tr class="memdesc:ga687eb5fbcb487fa34c66099941b7a8f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function registers a user-defined custom video mode timing table with video_common.  <a href="group__video__common.html#ga687eb5fbcb487fa34c66099941b7a8f0">More...</a><br/></td></tr>
<tr class="separator:ga687eb5fbcb487fa34c66099941b7a8f0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafd582f23dd41945cf74df9d9bf364f55"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__common.html#gafd582f23dd41945cf74df9d9bf364f55">XVidC_UnregisterCustomTimingModes</a> (void)</td></tr>
<tr class="memdesc:gafd582f23dd41945cf74df9d9bf364f55"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function unregisters the user-defined custom video mode timing table previously registered by <a class="el" href="group__video__common.html#ga687eb5fbcb487fa34c66099941b7a8f0" title="This function registers a user-defined custom video mode timing table with video_common. ">XVidC_RegisterCustomTimingModes()</a>.  <a href="group__video__common.html#gafd582f23dd41945cf74df9d9bf364f55">More...</a><br/></td></tr>
<tr class="separator:gafd582f23dd41945cf74df9d9bf364f55"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8b9e588104dbb1c2859fa29afee60d65"><td class="memItemLeft" align="right" valign="top">u64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__common.html#ga8b9e588104dbb1c2859fa29afee60d65">XVidC_GetPixelClockHzByHVFr</a> (u32 HTotal, u32 VTotal, u8 FrameRate)</td></tr>
<tr class="memdesc:ga8b9e588104dbb1c2859fa29afee60d65"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function calculates pixel clock based on the inputs.  <a href="group__video__common.html#ga8b9e588104dbb1c2859fa29afee60d65">More...</a><br/></td></tr>
<tr class="separator:ga8b9e588104dbb1c2859fa29afee60d65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae37000ca466121ef99a1e1fd4b587d91"><td class="memItemLeft" align="right" valign="top">u64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__common.html#gae37000ca466121ef99a1e1fd4b587d91">XVidC_GetPixelClockHzByVmId</a> (<a class="el" href="group__video__common.html#ga562f08faf2fc329b1cd7147b3d66ef53">XVidC_VideoMode</a> VmId)</td></tr>
<tr class="memdesc:gae37000ca466121ef99a1e1fd4b587d91"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function calculates pixel clock from video mode.  <a href="group__video__common.html#gae37000ca466121ef99a1e1fd4b587d91">More...</a><br/></td></tr>
<tr class="separator:gae37000ca466121ef99a1e1fd4b587d91"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7b982d86111b66608e263b5ecd639e42"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__video__common.html#gae8750e69caf5a7f747fbf410b14f447e">XVidC_VideoFormat</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__common.html#ga7b982d86111b66608e263b5ecd639e42">XVidC_GetVideoFormat</a> (<a class="el" href="group__video__common.html#ga562f08faf2fc329b1cd7147b3d66ef53">XVidC_VideoMode</a> VmId)</td></tr>
<tr class="memdesc:ga7b982d86111b66608e263b5ecd639e42"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function checks if the input video mode is interlaced/progressive based on its ID from the video timings table.  <a href="group__video__common.html#ga7b982d86111b66608e263b5ecd639e42">More...</a><br/></td></tr>
<tr class="separator:ga7b982d86111b66608e263b5ecd639e42"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0bea011c3bea29cbae6263599ca9ff06"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__common.html#ga0bea011c3bea29cbae6263599ca9ff06">XVidC_IsInterlaced</a> (<a class="el" href="group__video__common.html#ga562f08faf2fc329b1cd7147b3d66ef53">XVidC_VideoMode</a> VmId)</td></tr>
<tr class="memdesc:ga0bea011c3bea29cbae6263599ca9ff06"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function checks if the input video mode is interlaced based on its ID from the video timings table.  <a href="group__video__common.html#ga0bea011c3bea29cbae6263599ca9ff06">More...</a><br/></td></tr>
<tr class="separator:ga0bea011c3bea29cbae6263599ca9ff06"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3be40034baa818fc42e861f7f033afe8"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="struct_x_vid_c___video_timing_mode.html">XVidC_VideoTimingMode</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__common.html#ga3be40034baa818fc42e861f7f033afe8">XVidC_GetVideoModeData</a> (<a class="el" href="group__video__common.html#ga562f08faf2fc329b1cd7147b3d66ef53">XVidC_VideoMode</a> VmId)</td></tr>
<tr class="memdesc:ga3be40034baa818fc42e861f7f033afe8"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns the pointer to video mode data at index provided.  <a href="group__video__common.html#ga3be40034baa818fc42e861f7f033afe8">More...</a><br/></td></tr>
<tr class="separator:ga3be40034baa818fc42e861f7f033afe8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga536ee41269fe7c0519dc8c3838af2d93"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__common.html#ga536ee41269fe7c0519dc8c3838af2d93">XVidC_GetVideoModeStr</a> (<a class="el" href="group__video__common.html#ga562f08faf2fc329b1cd7147b3d66ef53">XVidC_VideoMode</a> VmId)</td></tr>
<tr class="memdesc:ga536ee41269fe7c0519dc8c3838af2d93"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns the resolution name for index specified.  <a href="group__video__common.html#ga536ee41269fe7c0519dc8c3838af2d93">More...</a><br/></td></tr>
<tr class="separator:ga536ee41269fe7c0519dc8c3838af2d93"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3a1ddd84b3b0115149c1b0820c6ba6f4"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__common.html#ga3a1ddd84b3b0115149c1b0820c6ba6f4">XVidC_GetFrameRateStr</a> (<a class="el" href="group__video__common.html#ga562f08faf2fc329b1cd7147b3d66ef53">XVidC_VideoMode</a> VmId)</td></tr>
<tr class="memdesc:ga3a1ddd84b3b0115149c1b0820c6ba6f4"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns the frame rate name for index specified.  <a href="group__video__common.html#ga3a1ddd84b3b0115149c1b0820c6ba6f4">More...</a><br/></td></tr>
<tr class="separator:ga3a1ddd84b3b0115149c1b0820c6ba6f4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8b0d0986815d88136d4ffae6118325e5"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__common.html#ga8b0d0986815d88136d4ffae6118325e5">XVidC_GetColorFormatStr</a> (<a class="el" href="group__video__common.html#gaa562703f77eeee8ef4a222f1b99c8633">XVidC_ColorFormat</a> ColorFormatId)</td></tr>
<tr class="memdesc:ga8b0d0986815d88136d4ffae6118325e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns the color format name for index specified.  <a href="group__video__common.html#ga8b0d0986815d88136d4ffae6118325e5">More...</a><br/></td></tr>
<tr class="separator:ga8b0d0986815d88136d4ffae6118325e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5359c410dfcc1bb7a851f77f0b92b287"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__video__common.html#gac192cb9c275d8ef2c985646f420c1a4e">XVidC_FrameRate</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__common.html#ga5359c410dfcc1bb7a851f77f0b92b287">XVidC_GetFrameRate</a> (<a class="el" href="group__video__common.html#ga562f08faf2fc329b1cd7147b3d66ef53">XVidC_VideoMode</a> VmId)</td></tr>
<tr class="memdesc:ga5359c410dfcc1bb7a851f77f0b92b287"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns the frame rate for index specified.  <a href="group__video__common.html#ga5359c410dfcc1bb7a851f77f0b92b287">More...</a><br/></td></tr>
<tr class="separator:ga5359c410dfcc1bb7a851f77f0b92b287"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga88a549f52e28fcf7b3e249f42e847bc1"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="struct_x_vid_c___video_timing.html">XVidC_VideoTiming</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__common.html#ga88a549f52e28fcf7b3e249f42e847bc1">XVidC_GetTimingInfo</a> (<a class="el" href="group__video__common.html#ga562f08faf2fc329b1cd7147b3d66ef53">XVidC_VideoMode</a> VmId)</td></tr>
<tr class="memdesc:ga88a549f52e28fcf7b3e249f42e847bc1"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns the timing parameters for specified resolution.  <a href="group__video__common.html#ga88a549f52e28fcf7b3e249f42e847bc1">More...</a><br/></td></tr>
<tr class="separator:ga88a549f52e28fcf7b3e249f42e847bc1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6a1bb6f49090b265fa2ae843c65f33b2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__common.html#ga6a1bb6f49090b265fa2ae843c65f33b2">XVidC_ReportStreamInfo</a> (const <a class="el" href="struct_x_vid_c___video_stream.html">XVidC_VideoStream</a> *Stream)</td></tr>
<tr class="memdesc:ga6a1bb6f49090b265fa2ae843c65f33b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function prints the stream information on STDIO/UART console.  <a href="group__video__common.html#ga6a1bb6f49090b265fa2ae843c65f33b2">More...</a><br/></td></tr>
<tr class="separator:ga6a1bb6f49090b265fa2ae843c65f33b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga420d4dcb3a706e55bd00d8b3522e9336"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__common.html#ga420d4dcb3a706e55bd00d8b3522e9336">XVidC_ReportTiming</a> (const <a class="el" href="struct_x_vid_c___video_timing.html">XVidC_VideoTiming</a> *Timing, u8 IsInterlaced)</td></tr>
<tr class="memdesc:ga420d4dcb3a706e55bd00d8b3522e9336"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function prints timing information on STDIO/Uart console.  <a href="group__video__common.html#ga420d4dcb3a706e55bd00d8b3522e9336">More...</a><br/></td></tr>
<tr class="separator:ga420d4dcb3a706e55bd00d8b3522e9336"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1d00a23344bac2c8f31661ed59e8c573"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__common.html#ga1d00a23344bac2c8f31661ed59e8c573">XVidC_Get3DFormatStr</a> (<a class="el" href="group__video__common.html#ga3f5c78f83e56747ade72ebb51cafffc5">XVidC_3DFormat</a> Format)</td></tr>
<tr class="memdesc:ga1d00a23344bac2c8f31661ed59e8c573"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns a string representation of the enumerated type, XVidC_3DFormat.  <a href="group__video__common.html#ga1d00a23344bac2c8f31661ed59e8c573">More...</a><br/></td></tr>
<tr class="separator:ga1d00a23344bac2c8f31661ed59e8c573"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga39b8b95d5bd27e43c55e7af11265c7e0"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__common.html#ga39b8b95d5bd27e43c55e7af11265c7e0">XVidC_SetVideoStream</a> (<a class="el" href="struct_x_vid_c___video_stream.html">XVidC_VideoStream</a> *VidStrmPtr, <a class="el" href="group__video__common.html#ga562f08faf2fc329b1cd7147b3d66ef53">XVidC_VideoMode</a> VmId, <a class="el" href="group__video__common.html#gaa562703f77eeee8ef4a222f1b99c8633">XVidC_ColorFormat</a> ColorFormat, <a class="el" href="group__video__common.html#ga8006bc80e39c26ee0081647990b9fedc">XVidC_ColorDepth</a> Bpc, <a class="el" href="group__video__common.html#ga37beb8afba8203e270e2df7e67f720ec">XVidC_PixelsPerClock</a> Ppc)</td></tr>
<tr class="memdesc:ga39b8b95d5bd27e43c55e7af11265c7e0"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets the VideoStream structure for the specified video format.  <a href="group__video__common.html#ga39b8b95d5bd27e43c55e7af11265c7e0">More...</a><br/></td></tr>
<tr class="separator:ga39b8b95d5bd27e43c55e7af11265c7e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac16f1d37cc0fd40e467411ca816fc9ef"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__common.html#gac16f1d37cc0fd40e467411ca816fc9ef">XVidC_Set3DVideoStream</a> (<a class="el" href="struct_x_vid_c___video_stream.html">XVidC_VideoStream</a> *VidStrmPtr, <a class="el" href="group__video__common.html#ga562f08faf2fc329b1cd7147b3d66ef53">XVidC_VideoMode</a> VmId, <a class="el" href="group__video__common.html#gaa562703f77eeee8ef4a222f1b99c8633">XVidC_ColorFormat</a> ColorFormat, <a class="el" href="group__video__common.html#ga8006bc80e39c26ee0081647990b9fedc">XVidC_ColorDepth</a> Bpc, <a class="el" href="group__video__common.html#ga37beb8afba8203e270e2df7e67f720ec">XVidC_PixelsPerClock</a> Ppc, <a class="el" href="struct_x_vid_c__3_d_info.html">XVidC_3DInfo</a> *Info3DPtr)</td></tr>
<tr class="memdesc:gac16f1d37cc0fd40e467411ca816fc9ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets the VideoStream structure for the specified 3D video format.  <a href="group__video__common.html#gac16f1d37cc0fd40e467411ca816fc9ef">More...</a><br/></td></tr>
<tr class="separator:gac16f1d37cc0fd40e467411ca816fc9ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0a1cda75da460feccd4ab2c2ee712fa5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__video__common.html#ga562f08faf2fc329b1cd7147b3d66ef53">XVidC_VideoMode</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__common.html#ga0a1cda75da460feccd4ab2c2ee712fa5">XVidC_GetVideoModeId</a> (u32 Width, u32 Height, u32 FrameRate, u8 IsInterlaced)</td></tr>
<tr class="memdesc:ga0a1cda75da460feccd4ab2c2ee712fa5"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns the Video Mode ID that matches the detected input width, height, frame rate and I/P flag.  <a href="group__video__common.html#ga0a1cda75da460feccd4ab2c2ee712fa5">More...</a><br/></td></tr>
<tr class="separator:ga0a1cda75da460feccd4ab2c2ee712fa5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga268ce8ec4d2d07109eb7795073e04cbb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__video__common.html#ga562f08faf2fc329b1cd7147b3d66ef53">XVidC_VideoMode</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__common.html#ga268ce8ec4d2d07109eb7795073e04cbb">XVidC_GetVideoModeIdExtensive</a> (<a class="el" href="struct_x_vid_c___video_timing.html">XVidC_VideoTiming</a> *Timing, u32 FrameRate, u8 IsInterlaced, u8 IsExtensive)</td></tr>
<tr class="memdesc:ga268ce8ec4d2d07109eb7795073e04cbb"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns the Video Mode ID that matches the detected input timing, frame rate and I/P flag.  <a href="group__video__common.html#ga268ce8ec4d2d07109eb7795073e04cbb">More...</a><br/></td></tr>
<tr class="separator:ga268ce8ec4d2d07109eb7795073e04cbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4377fff1a8e427e5f7bb642c5b115046"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__video__common.html#ga562f08faf2fc329b1cd7147b3d66ef53">XVidC_VideoMode</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__common.html#ga4377fff1a8e427e5f7bb642c5b115046">XVidC_GetVideoModeIdRb</a> (u32 Width, u32 Height, u32 FrameRate, u8 IsInterlaced, u8 RbN)</td></tr>
<tr class="memdesc:ga4377fff1a8e427e5f7bb642c5b115046"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns the video mode ID that matches the detected input width, height, frame rate, interlaced or progressive, and reduced blanking.  <a href="group__video__common.html#ga4377fff1a8e427e5f7bb642c5b115046">More...</a><br/></td></tr>
<tr class="separator:ga4377fff1a8e427e5f7bb642c5b115046"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga562322a65704c3d6a2617b9f5e5d1717"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__video__common.html#ga562f08faf2fc329b1cd7147b3d66ef53">XVidC_VideoMode</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__video__common.html#ga562322a65704c3d6a2617b9f5e5d1717">XVidC_GetVideoModeIdWBlanking</a> (const <a class="el" href="struct_x_vid_c___video_timing.html">XVidC_VideoTiming</a> *Timing, u32 FrameRate, u8 IsInterlaced)</td></tr>
<tr class="memdesc:ga562322a65704c3d6a2617b9f5e5d1717"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns the Video Mode ID that matches the detected input timing, frame rate and I/P flag.  <a href="group__video__common.html#ga562322a65704c3d6a2617b9f5e5d1717">More...</a><br/></td></tr>
<tr class="separator:ga562322a65704c3d6a2617b9f5e5d1717"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
